Skip to content

[scala-sttp4-jsoniter] extend Primitive type with UUID, LocalDate and OffsetDateTime#23801

Open
reynaldjoabet wants to merge 1 commit into
OpenAPITools:masterfrom
reynaldjoabet:scala-sttp4-jsoniter-extend-primitive-type
Open

[scala-sttp4-jsoniter] extend Primitive type with UUID, LocalDate and OffsetDateTime#23801
reynaldjoabet wants to merge 1 commit into
OpenAPITools:masterfrom
reynaldjoabet:scala-sttp4-jsoniter-extend-primitive-type

Conversation

@reynaldjoabet
Copy link
Copy Markdown
Contributor

@reynaldjoabet reynaldjoabet commented May 17, 2026 •
edited
Loading

Extend the Primitive union type in helpers.mustache with UUID,
LocalDate, and OffsetDateTime so that path, query, header, cookie, and
form parameters typed with these formats serialize via .toString() on the
fast primitive path. Without this, fields generated from format: uuid,
format: date, and format: date-time fall through to the Mirror-based
object path and fail at compile time because they are not products or sums.

Add an asString extension method on Primitive.A bare .toString is
correct for UUID and the numeric/boolean/string primitives, but produces the
wrong representation for Java's default LocalDate/
OffsetDateTime as toString on these does not match the expected wire format. asString
formats OffsetDateTime with DateTimeFormatter.ISO_OFFSET_DATE_TIME and LocalDate
with ISO_LOCAL_DATE, falling back to .toString for everything else, so date
and date-time parameters are emitted as ISO-8601 strings.

@lbialy @flsh86

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Extended Primitive in scala-sttp4-jsoniter to include UUID, LocalDate, and OffsetDateTime, and added ISO string formatting via a new asString fast path across all parameter serializers. This removes the Mirror fallback and fixes compile errors in generated clients.

  • Bug Fixes
    • Path, query, header, cookie, and form params with these formats now serialize as primitives using ISO/RFC 3339 strings and compile.
    • Updated petstore sample to reflect the new Primitive union and formatting.

Written for commit 03a7f9b. Summary will update on new commits.

Review in cubic

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed May 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Re-trigger cubic

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 18, 2026

thanks for the PR

cc @clasnake (2017/07), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) @Fish86 (2023/06)

@wing328 wing328 added this to the 7.23.0 milestone May 18, 2026
@wing328
Copy link
Copy Markdown
Member

wing328 commented May 19, 2026

@reynaldjoabet are you using this change in your production environment to confirm it works for your use cases?

@wing328
Copy link
Copy Markdown
Member

wing328 commented May 20, 2026

Is there a minimal spec to easily reproduce the issue and confirm the fix?

That will help speed up the review and get it merged sooner

@reynaldjoabet
Copy link
Copy Markdown
Contributor Author

reynaldjoabet commented May 21, 2026 •
edited
Loading

Is there a minimal spec to easily reproduce the issue and confirm the fix?

Yes. Three single-parameter snippets, each one independently reproduces a failure on the current master:

1. format: uuid on a header

parameters:
  - name: x-fapi-interaction-id
    in: header
    required: true
    schema:
      type: string
      format: uuid
.headers(HeaderSerializable.serialize("x-fapi-interaction-id", xFapiInteractionId, false))
[error] No given instance of type scala.deriving.Mirror.Of[java.util.UUID] was found.
[error] Failed to synthesize an instance of type scala.deriving.Mirror.Of[java.util.UUID]:
[error]   * class UUID is not a generic product because it is not a case class
[error]   * class UUID is not a generic sum because it is not a sealed class

2. format: date-time on a header

parameters:
  - name: x-fapi-auth-date
    in: header
    required: false
    schema:
      type: string
      format: date-time
.headers(HeaderSerializable.serialize("x-fapi-auth-date", xFapiAuthDate, false))
[error] No given instance of type scala.deriving.Mirror.Of[java.time.OffsetDateTime] was found.
[error] Failed to synthesize an instance of type scala.deriving.Mirror.Of[java.time.OffsetDateTime]:
[error]   * class OffsetDateTime is not a generic product because it is not a case class
[error]   * class OffsetDateTime is not a generic sum because it is not a sealed class

3. format: date on a query parameter

parameters:
  - name: fromBookingDate
    in: query
    schema:
      type: string
      format: date
.addParams(FormSerializable.serialize("fromBookingDate", fromBookingDate, FormStyleFormat.FORM, true): _*)
[error] No given instance of type scala.deriving.Mirror.Of[java.time.LocalDate] was found.
[error] Failed to synthesize an instance of type scala.deriving.Mirror.Of[java.time.LocalDate]:
[error]   * class LocalDate is not a generic product because it is not a case class
[error]   * class LocalDate is not a generic sum because it is not a sealed class

Root cause

helpers.mustache declares:

type Primitive = String | Short | Int | Long | Float | Double | BigDecimal | Boolean

but the generator emits UUID / OffsetDateTime / LocalDate for the three formats above. The inline match falls through to the summonInline[Mirror.Of[T]] branch, which can't synthesize a Mirror for a Java class.

@reynaldjoabet reynaldjoabet force-pushed the scala-sttp4-jsoniter-extend-primitive-type branch from 95ad1f8 to 03a7f9b Compare June 3, 2026 22:57
cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Jun 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cubic-dev-ai cubic-dev-ai[bot] cubic-dev-ai[bot] left review comments

Assignees

No one assigned

Labels

Client: Scala Enhancement: General

Projects

None yet

Milestone

7.23.0

Development

Successfully merging this pull request may close these issues.

2 participants

@reynaldjoabet @wing328